RTP OUTBOUND

The RTP OUT API enables to process outgoing Real-Time Payments (RTP) transactions instantly.

Method: POST

{{localCEUrl}}/analytics/rest/eventApi/event

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
InstructionIdentification Mandatory	String Unique identifier of the payment instruction Example – "f9a820da-7bcd-4941-b85c-201169ccf41a"
EndToEndIdentification Optional	String Unique identifier to track the transaction any time during the process Example – "31fe4401-d804-441e-b67a-44016b99b08f"
Reason Optional	String Reason or purpose given for the transaction Example – "Loan Repayment"
Channel Optional	String Channel through which the transaction happens Example – "TCH"
TransactionType Optional	String Type of transaction Example – "RTP_OUT"
TransactionCode Optional	String Specific code for the transaction type Example – "TCH_RTP_OUT"
Source Optional	String Name of the source system from where the payment request is initiated Example – "LEDGER"
TransactionAmount Mandatory	Object
Amount Mandatory	String Amount of the transaction Example – "21.00"
Currency Mandatory	String Currency type of the transaction amount Example – "USD"
Debtor Required	Object
CustomerType Optional	String Customer type of the debtor (sender), which can possibly be the ‘Account Holder', ‘Non-account Holder', ‘Account Holder Business' or ‘TSP' Example – "ACCOUNT_HOLDER"
UserType Optional	String Type of the user based on user-role, which can be ‘Individual' or ‘Legal Rep' Example – "INDIVIDUAL"
Identification Optional	String Individual ID of the debtor Example – "894100103"
IdentificationType Optional	String Type of identification used for individual ID Example – "SSN"
CustomerNumber Optional	String Unique ID provided for the debtor as a customer Example – "894100103"
InstitutionNumber Optional	String Unique ID that identifies the financial institution Example – "123456789012345"
Name Required	String Customer name of the debtor Example – "Benjamin Hill"
NameInFile Optional	String Name of the debtor given in the payment instruction Example – "Benjamin"
Gender Optional	String Gender of the debtor as a customer Example – "Male"
DebtorDateOfBirth Optional	Object
Year Optional	String Birth year of the debtor Example – "1974"
Month Optional	String Birth month of the debtor Example – "05"
Day Optional	String Birth year of the debtor Example – "17"
DateOfBirth Optional	String Date of birth of debtor in YYYYMMDD format Example – "19740517"
DebtorPostalAddress Optional	Object
AddressType Optional	String Address type of debtor Example – "HOUSE"
AddressLine1 Optional	String Line 1 of debtor address Example – "2745 SW VILLA DIRAQ"
AddressLine2 Optional	String Line 2 of debtor address Example – "Apt 304"
City Optional	String City name of the debtor address Example – "Kansas City"
State Optional	String State of the debtor address Example – "MO"
ZipCode Optional	String Zip code of debtor address location Example – "66610"
CountryCode Optional	String Country code of debtor's country Example – "840"
Nationality Optional	String Nationality of the debtor Example – "USA"
Country Optional	String Country of the debtor's location Example – "USA"
DebtorContact Optional	Object
PrimaryEmail Optional	String Contact email ID of the debtor Example – "hill@gmail.com"
PrimaryPhone Optional	String Contact phone number of the debtor Example – "0076540014502"
DebtorAccount Optional	Object
AccountNumber Optional	String Account number of the debtor Example – "200502391928095"
AccountType Optional	String Type of the debtor's account Example – "CHECKING"
AccountName Optional	String Debtor's account name Example – "GENERAL ACCOUNT"
Institution Optional	Object
Name Optional	String Name of the debtor account financial institution Example – "Union Savings Bank"
Identification Optional	String Identification code of the debtor account financial institution, which is possibly the routing number Example – "011102502"
IdentificationType Optional	String Identification type of the debtor account financial institution Example – "ABA"
DebtorGeoLocation Optional	Object
Latitude Optional	String Geographical latitude of debtor's location Example – "13.02354160"
Longitude Optional	String Geographical longitude of debtor's location Example – "80.14923669"
Creditor Required	Object
CustomerType Optional	String Customer type of the creditor (receiver), which can possibly be the ‘Account Holder', ‘Account Holder Business' or ‘TSP' Example – "EXTERNAL"
UserType Optional	String User type of the creditor Example – "UNKNOWN"
Identification Optional	String Individual ID of the creditor Example – "994140005"
IdentificationType Optional	String Type of identification used for individual ID Example – "SSN"
CustomerNumber Optional	String Unique ID provided for the creditor as a customer Example – "994140005"
Name Required	String Customer name of the creditor Example – "Sally Granger"
CreditorAccount Optional	Object
AccountNumber Optional	String Account number of the creditor Example – "8346868364836483"
AccountType Optional	String Type of the creditor's account Example – "CHECKING"
AccountName Optional	String Creditor's account name Example – "INTERNAL"
Institution Optional	Object
Identification Optional	String Identification code of the creditor account financial institution, which is possibly the routing number Example – "021000021"
IdentificationType Optional	String Identification type of the creditor account financial institution Example – "ABA"
Name Optional	String Name of the creditor account financial institution Example – "JPMORGAN CHASE BANK"
CreditorDateOfBirth Optional	Object
Year Optional	String Birth year of the creditor Example – "1970"
Month Optional	String Birth month of the creditor Example – "11"
Day Optional	String Birth year of the creditor Example – "15"
CreditorPostalAddress Optional	Object
AddressType Optional	String Address type of creditor Example – "HOUSE"
AddressLine1 Optional	String Line 1 of creditor address Example – "3745 SW VENEZULA CUBARD IRANMA"
AddressLine2 Optional	String Line 2 of creditor address Example – "Suite C"
City Optional	String City name of the creditor address Example – "Topeka"
State Optional	String State of the creditor address Example – "KS"
ZipCode Optional	String Zip code of creditor address location Example – "66610"
CountryCode Optional	String Country code of creditor country Example – "840"
Nationality Optional	String Nationality of the creditor Example – "USA"
Country Optional	String Country of the creditor's location Example – "USA"
CreditorContact Optional	Object
PrimaryEmail Optional	String Contact email ID of the creditor Example – "sally@gmail.com"
PrimaryPhone Optional	String Contact phone number of the creditor Example – "00178500146156"
FedDetails Optional	Object
FedSender Optional	Object
Identification Optional	String Identification code of the sender bank of FED Example – "011102502"
IdentificationType Optional	String Identification type of the sender bank of FED Example – "ABA"
Name Optional	String Name of the sender bank of FED Example – "Union Savings Bank"
FedReceiver Optional	Object
Identification Optional	String Identification code of the receiver bank of FED Example – "021000021"
IdentificationType Optional	String Identification type of the receiver bank of FED Example – "ABA"
Name Optional	String Name of the receiver bank of FED Example – "JPMORGAN CHASE BANK"
Risk Optional	Object
MachineFingerPrint Optional	Object

Parameter

Description

InstructionIdentification

Mandatory

String

Unique identifier of the payment instruction

Example – "f9a820da-7bcd-4941-b85c-201169ccf41a"

EndToEndIdentification

Optional

String

Unique identifier to track the transaction any time during the process

Example – "31fe4401-d804-441e-b67a-44016b99b08f"

Reason

Optional

String

Reason or purpose given for the transaction

Example – "Loan Repayment"

Channel

Optional

String

Channel through which the transaction happens

Example – "TCH"

TransactionType

Optional

String

Type of transaction

Example – "RTP_OUT"

TransactionCode

Optional

String

Specific code for the transaction type

Example – "TCH_RTP_OUT"

Source

Optional

String

Name of the source system from where the payment request is initiated

Example – "LEDGER"

TransactionAmount

Mandatory

Object

Amount

Mandatory

String

Amount of the transaction

Example – "21.00"

Currency

Mandatory

String

Currency type of the transaction amount

Example – "USD"

Debtor

Required

Object

CustomerType

Optional

String

Customer type of the debtor (sender), which can possibly be the ‘Account Holder', ‘Non-account Holder', ‘Account Holder Business' or ‘TSP'

Example – "ACCOUNT_HOLDER"

UserType

Optional

String

Type of the user based on user-role, which can be ‘Individual' or ‘Legal Rep'

Example – "INDIVIDUAL"

Identification

Optional

String

Individual ID of the debtor

Example – "894100103"

IdentificationType

Optional

String

Type of identification used for individual ID

Example – "SSN"

CustomerNumber

Optional

String

Unique ID provided for the debtor as a customer

Example – "894100103"

InstitutionNumber

Optional

String

Unique ID that identifies the financial institution

Example – "123456789012345"

Name

Required

String

Customer name of the debtor

Example – "Benjamin Hill"

NameInFile

Optional

String

Name of the debtor given in the payment instruction

Example – "Benjamin"

Gender

Optional

String

Gender of the debtor as a customer

Example – "Male"

DebtorDateOfBirth

Optional

Object

Year

Optional

String

Birth year of the debtor

Example – "1974"

Month

Optional

String

Birth month of the debtor

Example – "05"

Day

Optional

String

Birth year of the debtor

Example – "17"

DateOfBirth

Optional

String

Date of birth of debtor in YYYYMMDD format

Example – "19740517"

DebtorPostalAddress

Optional

Object

AddressType

Optional

String

Address type of debtor

Example – "HOUSE"

AddressLine1

Optional

String

Line 1 of debtor address

Example – "2745 SW VILLA DIRAQ"

AddressLine2

Optional

String

Line 2 of debtor address

Example – "Apt 304"

City

Optional

String

City name of the debtor address

Example – "Kansas City"

State

Optional

String

State of the debtor address

Example – "MO"

ZipCode

Optional

String

Zip code of debtor address location

Example – "66610"

CountryCode

Optional

String

Country code of debtor's country

Example – "840"

Nationality

Optional

String

Nationality of the debtor

Example – "USA"

Country

Optional

String

Country of the debtor's location

Example – "USA"

DebtorContact

Optional

Object

PrimaryEmail

Optional

String

Contact email ID of the debtor

Example – "hill@gmail.com"

PrimaryPhone

Optional

String

Contact phone number of the debtor

Example – "0076540014502"

DebtorAccount

Optional

Object

AccountNumber

Optional

String

Account number of the debtor

Example – "200502391928095"

AccountType

Optional

String

Type of the debtor's account

Example – "CHECKING"

AccountName

Optional

String

Debtor's account name

Example – "GENERAL ACCOUNT"

Institution

Optional

Object

Name

Optional

String

Name of the debtor account financial institution

Example – "Union Savings Bank"

Identification

Optional

String

Identification code of the debtor account financial institution,

which is possibly the routing number

Example – "011102502"

IdentificationType

Optional

String

Identification type of the debtor account financial institution

Example – "ABA"

DebtorGeoLocation

Optional

Object

Latitude

Optional

String

Geographical latitude of debtor's location

Example – "13.02354160"

Longitude

Optional

String

Geographical longitude of debtor's location

Example – "80.14923669"

Creditor

Required

Object

CustomerType

Optional

String

Customer type of the creditor (receiver), which can possibly be the ‘Account Holder', ‘Account Holder Business' or ‘TSP'

Example – "EXTERNAL"

UserType

Optional

String

User type of the creditor

Example – "UNKNOWN"

Identification

Optional

String

Individual ID of the creditor

Example – "994140005"

IdentificationType

Optional

String

Type of identification used for individual ID

Example – "SSN"

CustomerNumber

Optional

String

Unique ID provided for the creditor as a customer

Example – "994140005"

Name

Required

String

Customer name of the creditor

Example – "Sally Granger"

CreditorAccount

Optional

Object

AccountNumber

Optional

String

Account number of the creditor

Example – "8346868364836483"

AccountType

Optional

String

Type of the creditor's account

Example – "CHECKING"

AccountName

Optional

String

Creditor's account name

Example – "INTERNAL"

Institution

Optional

Object

Identification

Optional

String

Identification code of the creditor account financial institution, which is possibly the routing number

Example – "021000021"

IdentificationType

Optional

String

Identification type of the creditor account financial institution

Example – "ABA"

Name

Optional

String

Name of the creditor account financial institution

Example – "JPMORGAN CHASE BANK"

CreditorDateOfBirth

Optional

Object

Year

Optional

String

Birth year of the creditor

Example – "1970"

Month

Optional

String

Birth month of the creditor

Example – "11"

Day

Optional

String

Birth year of the creditor

Example – "15"

CreditorPostalAddress

Optional

Object

AddressType

Optional

String

Address type of creditor

Example – "HOUSE"

AddressLine1

Optional

String

Line 1 of creditor address

Example – "3745 SW VENEZULA CUBARD IRANMA"

AddressLine2

Optional

String

Line 2 of creditor address

Example – "Suite C"

City

Optional

String

City name of the creditor address

Example – "Topeka"

State

Optional

String

State of the creditor address

Example – "KS"

ZipCode

Optional

String

Zip code of creditor address location

Example – "66610"

CountryCode

Optional

String

Country code of creditor country

Example – "840"

Nationality

Optional

String

Nationality of the creditor

Example – "USA"

Country

Optional

String

Country of the creditor's location

Example – "USA"

CreditorContact

Optional

Object

PrimaryEmail

Optional

String

Contact email ID of the creditor

Example – "sally@gmail.com"

PrimaryPhone

Optional

String

Contact phone number of the creditor

Example – "00178500146156"

FedDetails

Optional

Object

FedSender

Optional

Object

Identification

Optional

String

Identification code of the sender bank of FED

Example – "011102502"

IdentificationType

Optional

String

Identification type of the sender bank of FED

Example – "ABA"

Name

Optional

String

Name of the sender bank of FED

Example – "Union Savings Bank"

FedReceiver

Optional

Object

Identification

Optional

String

Identification code of the receiver bank of FED

Example – "021000021"

IdentificationType

Optional

String

Identification type of the receiver bank of FED

Example – "ABA"

Name

Optional

String

Name of the receiver bank of FED

Example – "JPMORGAN CHASE BANK"

Risk

Optional

Object

MachineFingerPrint

Optional

Object

cURL
C#
Go
NodeJs

curl --location --globoff '{{localCEUrl}}/analytics/rest/eventApi/event' \
--header 'Content-Type: application/json' \
--data-raw '{"InstructionIdentification":"f9a820da-7bcd-4941-b85c-201169ccf41a","EndToEndIdentification":"31fe4401-d804-441e-b67a-44016b99b08f","Reason":"Loan Repayment","Channel":"TCH","TranactionType":"RTP_OUT","TranactionCode":"TCH_RTP_OUT","Source":"LEDGER","TransactionAmount":{"Amount":"21.00","Currency":"USD"},"Debtor":{"CustomerType":"ACCOUNT_HOLDER","UserType":"INDIVIDUAL","Identification":"894100103","IdentificationType":"SSN","CustomerNumber":"894100103","InstitutionNumber":"123456789012345","Name":"Benjamin Hill","NameInFile":"Benjamin","Gender":"Male"},"DebtorDateOfBirth":{"Year":"1974","Month":"05","Day":"17","DateOfBirth":"19740517"},"DebtorPostalAddress":{"AddressType":"HOUSE","AddressLine1":"2745 SW VILLA DIRAQ","AddressLine2":"Apt 304","City":"Kansas City","State":"MO","ZipCode":"66610","CountryCode":"840","Nationality":"USA"},"DebtorContact":{"PrimaryEmail":"hill@gmail.com","PrimaryPhone":"0076540014502"},"DebtorAccount":{"AccountNumber":"200502391928095","AccountType":"CHECKING","AccountName":"GENERAL ACCOUNT","Institution":{"Name":"Union Savings Bank","Identification":"011102502","IdentificationType":"ABA"}},"DebtorGeoLocation":{"Latitude":"13.02354160","Longitude":"80.14923669"},"Creditor":{"CustomerType":"EXTERNAL","UserType":"UNKNOWN","Identification":"994140005","IdentificationType":"SSN","CustomerNumber":"994140005","Name":"Sally Granger"},"CreditorAccount":{"AccountNumber":"8346868364836483","AccountType":"CHECKING","AccountName":"EXTERNAL","Institution":{"Identification":"021000021","IdentificationType":"ABA","Name":"JPMORGAN CHASE BANK"}},"CreditorDateOfBirth":{"Year":"1970","Month":"11","Day":"15"},"CreditorPostalAddress":{"AddressType":"HOUSE","AddressLine1":"3745 SW VENEZULA CUBARD IRANMA","AddressLine2":"Suite C","City":"Topeka","State":"KS","ZipCode":"66610","CountryCode":"840","Nationality":" VENEZUALA ","Country":"VENEZUALA"},"CreditorContact":{"PrimaryEmail":"sally@gmail.com","PrimaryPhone":"00178500146156"},"FedDetails":{"FedSender":{"Identification":"011102502","IdentificationType":"ABA","Name":"Union Savings Bank"},"FedReceiver":{"Identification":"021000021","IdentificationType":"ABA","Name":"JPMORGAN CHASE BANK"}},"Risk":{"MachineFingerPrint":{"IpAddress":"98.186.126.180","OperatingSystem":"Mac OS","WebBrowser":"safari","Uuid":"7609EFD3-CED4-440F-9C18-D330EE9311FC","Model":"iPhone","SystemName":"iOS","SystemVersion":"13.3.1","PhoneName":"My IPHONE","Imei":"","SessionId":"","OperatingSystemFamily":"MAC_OS","OperatingSystemProducer":"Apple Computer, Inc."},"GeoLocation":{"Latitude":"39.75931104","Longitude":"-105.01091174"}}}'

var options = new RestClientOptions("{{localCEUrl}}/analytics/rest/eventApi/event")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""InstructionIdentification"": ""f9a820da-7bcd-4941-b85c-201169ccf41a"",
" + "\n" +
@"    ""EndToEndIdentification"": ""31fe4401-d804-441e-b67a-44016b99b08f"",
" + "\n" +
@"    ""Reason"": ""Loan Repayment"",
" + "\n" +
@"    ""Channel"": ""TCH"",
" + "\n" +
@"    ""TranactionType"": ""RTP_OUT"",
" + "\n" +
@"    ""TranactionCode"": ""TCH_RTP_OUT"",
" + "\n" +
@"    ""Source"": ""LEDGER"",
" + "\n" +
@"    ""TransactionAmount"": {
" + "\n" +
@"        ""Amount"": ""21.00"",
" + "\n" +
@"        ""Currency"": ""USD""
" + "\n" +
@"    },
" + "\n" +
@"    ""Debtor"": {
" + "\n" +
@"        ""CustomerType"": ""ACCOUNT_HOLDER"",
" + "\n" +
@"        ""UserType"": ""INDIVIDUAL"",
" + "\n" +
@"        ""Identification"": ""894100103"",
" + "\n" +
@"        ""IdentificationType"": ""SSN"",
" + "\n" +
@"        ""CustomerNumber"": ""894100103"",
" + "\n" +
@"        ""InstitutionNumber"": ""123456789012345"",
" + "\n" +
@"        ""Name"": ""Benjamin Hill"",
" + "\n" +
@"        ""NameInFile"": ""Benjamin"",
" + "\n" +
@"        ""Gender"": ""Male""
" + "\n" +
@"    },
" + "\n" +
@"    ""DebtorDateOfBirth"": {
" + "\n" +
@"        ""Year"": ""1974"",
" + "\n" +
@"        ""Month"": ""05"",
" + "\n" +
@"        ""Day"": ""17"",
" + "\n" +
@"        ""DateOfBirth"": ""19740517""
" + "\n" +
@"    },
" + "\n" +
@"    ""DebtorPostalAddress"": {
" + "\n" +
@"        ""AddressType"": ""HOUSE"",
" + "\n" +
@"        ""AddressLine1"": ""2745 SW VILLA DIRAQ"",
" + "\n" +
@"        ""AddressLine2"": ""Apt 304"",
" + "\n" +
@"        ""City"": ""Kansas City"",
" + "\n" +
@"        ""State"": ""MO"",
" + "\n" +
@"        ""ZipCode"": ""66610"",
" + "\n" +
@"        ""CountryCode"": ""840"",
" + "\n" +
@"        ""Nationality"": ""USA""
" + "\n" +
@"    },
" + "\n" +
@"    ""DebtorContact"": {
" + "\n" +
@"        ""PrimaryEmail"": ""hill@gmail.com"",
" + "\n" +
@"        ""PrimaryPhone"": ""0076540014502""
" + "\n" +
@"    },
" + "\n" +
@"    ""DebtorAccount"": {
" + "\n" +
@"        ""AccountNumber"": ""200502391928095"",
" + "\n" +
@"        ""AccountType"": ""CHECKING"",
" + "\n" +
@"        ""AccountName"": ""GENERAL ACCOUNT"",
" + "\n" +
@"        ""Institution"": {
" + "\n" +
@"            ""Name"": ""Union Savings Bank"",
" + "\n" +
@"            ""Identification"": ""011102502"",
" + "\n" +
@"            ""IdentificationType"": ""ABA""
" + "\n" +
@"        }
" + "\n" +
@"    },
" + "\n" +
@"    ""DebtorGeoLocation"": {
" + "\n" +
@"        ""Latitude"": ""13.02354160"",
" + "\n" +
@"        ""Longitude"": ""80.14923669""
" + "\n" +
@"    },
" + "\n" +
@"    ""Creditor"": {
" + "\n" +
@"        ""CustomerType"": ""EXTERNAL"",
" + "\n" +
@"        ""UserType"": ""UNKNOWN"",
" + "\n" +
@"        ""Identification"": ""994140005"",
" + "\n" +
@"        ""IdentificationType"": ""SSN"",
" + "\n" +
@"        ""CustomerNumber"": ""994140005"",
" + "\n" +
@"        ""Name"": ""Sally Granger""
" + "\n" +
@"    },
" + "\n" +
@"    ""CreditorAccount"": {
" + "\n" +
@"        ""AccountNumber"": ""8346868364836483"",
" + "\n" +
@"        ""AccountType"": ""CHECKING"",
" + "\n" +
@"        ""AccountName"": ""EXTERNAL"",
" + "\n" +
@"        ""Institution"": {
" + "\n" +
@"            ""Identification"": ""021000021"",
" + "\n" +
@"            ""IdentificationType"": ""ABA"",
" + "\n" +
@"            ""Name"": ""JPMORGAN CHASE BANK""
" + "\n" +
@"        }
" + "\n" +
@"    },
" + "\n" +
@"    ""CreditorDateOfBirth"": {
" + "\n" +
@"        ""Year"": ""1970"",
" + "\n" +
@"        ""Month"": ""11"",
" + "\n" +
@"        ""Day"": ""15""
" + "\n" +
@"    },
" + "\n" +
@"    ""CreditorPostalAddress"": {
" + "\n" +
@"        ""AddressType"": ""HOUSE"",
" + "\n" +
@"        ""AddressLine1"": ""3745 SW VENEZULA CUBARD IRANMA"",
" + "\n" +
@"        ""AddressLine2"": ""Suite C"",
" + "\n" +
@"        ""City"": ""Topeka"",
" + "\n" +
@"        ""State"": ""KS"",
" + "\n" +
@"        ""ZipCode"": ""66610"",
" + "\n" +
@"        ""CountryCode"": ""840"",
" + "\n" +
@"        ""Nationality"": "" VENEZUALA "",
" + "\n" +
@"        ""Country"": ""VENEZUALA""
" + "\n" +
@"    },
" + "\n" +
@"    ""CreditorContact"": {
" + "\n" +
@"        ""PrimaryEmail"": ""sally@gmail.com"",
" + "\n" +
@"        ""PrimaryPhone"": ""00178500146156""
" + "\n" +
@"    },
" + "\n" +
@"    ""FedDetails"": {
" + "\n" +
@"        ""FedSender"": {
" + "\n" +
@"            ""Identification"": ""011102502"",
" + "\n" +
@"            ""IdentificationType"": ""ABA"",
" + "\n" +
@"            ""Name"": ""Union Savings Bank""
" + "\n" +
@"        },
" + "\n" +
@"        ""FedReceiver"": {
" + "\n" +
@"            ""Identification"": ""021000021"",
" + "\n" +
@"            ""IdentificationType"": ""ABA"",
" + "\n" +
@"            ""Name"": ""JPMORGAN CHASE BANK""
" + "\n" +
@"        }
" + "\n" +
@"    },
" + "\n" +
@"    ""Risk"": {
" + "\n" +
@"        ""MachineFingerPrint"": {
" + "\n" +
@"            ""IpAddress"": ""98.186.126.180"",
" + "\n" +
@"            ""OperatingSystem"": ""Mac OS"",
" + "\n" +
@"            ""WebBrowser"": ""safari"",
" + "\n" +
@"            ""Uuid"": ""7609EFD3-CED4-440F-9C18-D330EE9311FC"",
" + "\n" +
@"            ""Model"": ""iPhone"",
" + "\n" +
@"            ""SystemName"": ""iOS"",
" + "\n" +
@"            ""SystemVersion"": ""13.3.1"",
" + "\n" +
@"            ""PhoneName"": ""My IPHONE"",
" + "\n" +
@"            ""Imei"": """",
" + "\n" +
@"            ""SessionId"": """",
" + "\n" +
@"            ""OperatingSystemFamily"": ""MAC_OS"",
" + "\n" +
@"            ""OperatingSystemProducer"": ""Apple Computer, Inc.""
" + "\n" +
@"        },
" + "\n" +
@"        ""GeoLocation"": {
" + "\n" +
@"            ""Latitude"": ""39.75931104"",
" + "\n" +
@"            ""Longitude"": ""-105.01091174""
" + "\n" +
@"        }
" + "\n" +
@"    }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{localCEUrl}}/analytics/rest/eventApi/event"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "InstructionIdentification": "f9a820da-7bcd-4941-b85c-201169ccf41a",`+"
"+`
    "EndToEndIdentification": "31fe4401-d804-441e-b67a-44016b99b08f",`+"
"+`
    "Reason": "Loan Repayment",`+"
"+`
    "Channel": "TCH",`+"
"+`
    "TranactionType": "RTP_OUT",`+"
"+`
    "TranactionCode": "TCH_RTP_OUT",`+"
"+`
    "Source": "LEDGER",`+"
"+`
    "TransactionAmount": {`+"
"+`
        "Amount": "21.00",`+"
"+`
        "Currency": "USD"`+"
"+`
    },`+"
"+`
    "Debtor": {`+"
"+`
        "CustomerType": "ACCOUNT_HOLDER",`+"
"+`
        "UserType": "INDIVIDUAL",`+"
"+`
        "Identification": "894100103",`+"
"+`
        "IdentificationType": "SSN",`+"
"+`
        "CustomerNumber": "894100103",`+"
"+`
        "InstitutionNumber": "123456789012345",`+"
"+`
        "Name": "Benjamin Hill",`+"
"+`
        "NameInFile": "Benjamin",`+"
"+`
        "Gender": "Male"`+"
"+`
    },`+"
"+`
    "DebtorDateOfBirth": {`+"
"+`
        "Year": "1974",`+"
"+`
        "Month": "05",`+"
"+`
        "Day": "17",`+"
"+`
        "DateOfBirth": "19740517"`+"
"+`
    },`+"
"+`
    "DebtorPostalAddress": {`+"
"+`
        "AddressType": "HOUSE",`+"
"+`
        "AddressLine1": "2745 SW VILLA DIRAQ",`+"
"+`
        "AddressLine2": "Apt 304",`+"
"+`
        "City": "Kansas City",`+"
"+`
        "State": "MO",`+"
"+`
        "ZipCode": "66610",`+"
"+`
        "CountryCode": "840",`+"
"+`
        "Nationality": "USA"`+"
"+`
    },`+"
"+`
    "DebtorContact": {`+"
"+`
        "PrimaryEmail": "hill@gmail.com",`+"
"+`
        "PrimaryPhone": "0076540014502"`+"
"+`
    },`+"
"+`
    "DebtorAccount": {`+"
"+`
        "AccountNumber": "200502391928095",`+"
"+`
        "AccountType": "CHECKING",`+"
"+`
        "AccountName": "GENERAL ACCOUNT",`+"
"+`
        "Institution": {`+"
"+`
            "Name": "Union Savings Bank",`+"
"+`
            "Identification": "011102502",`+"
"+`
            "IdentificationType": "ABA"`+"
"+`
        }`+"
"+`
    },`+"
"+`
    "DebtorGeoLocation": {`+"
"+`
        "Latitude": "13.02354160",`+"
"+`
        "Longitude": "80.14923669"`+"
"+`
    },`+"
"+`
    "Creditor": {`+"
"+`
        "CustomerType": "EXTERNAL",`+"
"+`
        "UserType": "UNKNOWN",`+"
"+`
        "Identification": "994140005",`+"
"+`
        "IdentificationType": "SSN",`+"
"+`
        "CustomerNumber": "994140005",`+"
"+`
        "Name": "Sally Granger"`+"
"+`
    },`+"
"+`
    "CreditorAccount": {`+"
"+`
        "AccountNumber": "8346868364836483",`+"
"+`
        "AccountType": "CHECKING",`+"
"+`
        "AccountName": "EXTERNAL",`+"
"+`
        "Institution": {`+"
"+`
            "Identification": "021000021",`+"
"+`
            "IdentificationType": "ABA",`+"
"+`
            "Name": "JPMORGAN CHASE BANK"`+"
"+`
        }`+"
"+`
    },`+"
"+`
    "CreditorDateOfBirth": {`+"
"+`
        "Year": "1970",`+"
"+`
        "Month": "11",`+"
"+`
        "Day": "15"`+"
"+`
    },`+"
"+`
    "CreditorPostalAddress": {`+"
"+`
        "AddressType": "HOUSE",`+"
"+`
        "AddressLine1": "3745 SW VENEZULA CUBARD IRANMA",`+"
"+`
        "AddressLine2": "Suite C",`+"
"+`
        "City": "Topeka",`+"
"+`
        "State": "KS",`+"
"+`
        "ZipCode": "66610",`+"
"+`
        "CountryCode": "840",`+"
"+`
        "Nationality": " VENEZUALA ",`+"
"+`
        "Country": "VENEZUALA"`+"
"+`
    },`+"
"+`
    "CreditorContact": {`+"
"+`
        "PrimaryEmail": "sally@gmail.com",`+"
"+`
        "PrimaryPhone": "00178500146156"`+"
"+`
    },`+"
"+`
    "FedDetails": {`+"
"+`
        "FedSender": {`+"
"+`
            "Identification": "011102502",`+"
"+`
            "IdentificationType": "ABA",`+"
"+`
            "Name": "Union Savings Bank"`+"
"+`
        },`+"
"+`
        "FedReceiver": {`+"
"+`
            "Identification": "021000021",`+"
"+`
            "IdentificationType": "ABA",`+"
"+`
            "Name": "JPMORGAN CHASE BANK"`+"
"+`
        }`+"
"+`
    },`+"
"+`
    "Risk": {`+"
"+`
        "MachineFingerPrint": {`+"
"+`
            "IpAddress": "98.186.126.180",`+"
"+`
            "OperatingSystem": "Mac OS",`+"
"+`
            "WebBrowser": "safari",`+"
"+`
            "Uuid": "7609EFD3-CED4-440F-9C18-D330EE9311FC",`+"
"+`
            "Model": "iPhone",`+"
"+`
            "SystemName": "iOS",`+"
"+`
            "SystemVersion": "13.3.1",`+"
"+`
            "PhoneName": "My IPHONE",`+"
"+`
            "Imei": "",`+"
"+`
            "SessionId": "",`+"
"+`
            "OperatingSystemFamily": "MAC_OS",`+"
"+`
            "OperatingSystemProducer": "Apple Computer, Inc."`+"
"+`
        },`+"
"+`
        "GeoLocation": {`+"
"+`
            "Latitude": "39.75931104",`+"
"+`
            "Longitude": "-105.01091174"`+"
"+`
        }`+"
"+`
    }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{localCEUrl}}',
  'path': '/analytics/rest/eventApi/event',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "InstructionIdentification": "f9a820da-7bcd-4941-b85c-201169ccf41a",
  "EndToEndIdentification": "31fe4401-d804-441e-b67a-44016b99b08f",
  "Reason": "Loan Repayment",
  "Channel": "TCH",
  "TranactionType": "RTP_OUT",
  "TranactionCode": "TCH_RTP_OUT",
  "Source": "LEDGER",
  "TransactionAmount": {
    "Amount": "21.00",
    "Currency": "USD"
  },
  "Debtor": {
    "CustomerType": "ACCOUNT_HOLDER",
    "UserType": "INDIVIDUAL",
    "Identification": "894100103",
    "IdentificationType": "SSN",
    "CustomerNumber": "894100103",
    "InstitutionNumber": "123456789012345",
    "Name": "Benjamin Hill",
    "NameInFile": "Benjamin",
    "Gender": "Male"
  },
  "DebtorDateOfBirth": {
    "Year": "1974",
    "Month": "05",
    "Day": "17",
    "DateOfBirth": "19740517"
  },
  "DebtorPostalAddress": {
    "AddressType": "HOUSE",
    "AddressLine1": "2745 SW VILLA DIRAQ",
    "AddressLine2": "Apt 304",
    "City": "Kansas City",
    "State": "MO",
    "ZipCode": "66610",
    "CountryCode": "840",
    "Nationality": "USA"
  },
  "DebtorContact": {
    "PrimaryEmail": "hill@gmail.com",
    "PrimaryPhone": "0076540014502"
  },
  "DebtorAccount": {
    "AccountNumber": "200502391928095",
    "AccountType": "CHECKING",
    "AccountName": "GENERAL ACCOUNT",
    "Institution": {
      "Name": "Union Savings Bank",
      "Identification": "011102502",
      "IdentificationType": "ABA"
    }
  },
  "DebtorGeoLocation": {
    "Latitude": "13.02354160",
    "Longitude": "80.14923669"
  },
  "Creditor": {
    "CustomerType": "EXTERNAL",
    "UserType": "UNKNOWN",
    "Identification": "994140005",
    "IdentificationType": "SSN",
    "CustomerNumber": "994140005",
    "Name": "Sally Granger"
  },
  "CreditorAccount": {
    "AccountNumber": "8346868364836483",
    "AccountType": "CHECKING",
    "AccountName": "EXTERNAL",
    "Institution": {
      "Identification": "021000021",
      "IdentificationType": "ABA",
      "Name": "JPMORGAN CHASE BANK"
    }
  },
  "CreditorDateOfBirth": {
    "Year": "1970",
    "Month": "11",
    "Day": "15"
  },
  "CreditorPostalAddress": {
    "AddressType": "HOUSE",
    "AddressLine1": "3745 SW VENEZULA CUBARD IRANMA",
    "AddressLine2": "Suite C",
    "City": "Topeka",
    "State": "KS",
    "ZipCode": "66610",
    "CountryCode": "840",
    "Nationality": " VENEZUALA ",
    "Country": "VENEZUALA"
  },
  "CreditorContact": {
    "PrimaryEmail": "sally@gmail.com",
    "PrimaryPhone": "00178500146156"
  },
  "FedDetails": {
    "FedSender": {
      "Identification": "011102502",
      "IdentificationType": "ABA",
      "Name": "Union Savings Bank"
    },
    "FedReceiver": {
      "Identification": "021000021",
      "IdentificationType": "ABA",
      "Name": "JPMORGAN CHASE BANK"
    }
  },
  "Risk": {
    "MachineFingerPrint": {
      "IpAddress": "98.186.126.180",
      "OperatingSystem": "Mac OS",
      "WebBrowser": "safari",
      "Uuid": "7609EFD3-CED4-440F-9C18-D330EE9311FC",
      "Model": "iPhone",
      "SystemName": "iOS",
      "SystemVersion": "13.3.1",
      "PhoneName": "My IPHONE",
      "Imei": "",
      "SessionId": "",
      "OperatingSystemFamily": "MAC_OS",
      "OperatingSystemProducer": "Apple Computer, Inc."
    },
    "GeoLocation": {
      "Latitude": "39.75931104",
      "Longitude": "-105.01091174"
    }
  }
});

req.write(postData);

req.end();

Body

{
  "InstructionIdentification": "f9a820da-7bcd-4941-b85c-201169ccf41a",
  "EndToEndIdentification": "31fe4401-d804-441e-b67a-44016b99b08f",
  "Reason": "Loan Repayment",
  "Channel": "TCH",
  "TranactionType": "RTP_OUT",
  "TranactionCode": "TCH_RTP_OUT",
  "Source": "LEDGER",
  "TransactionAmount": {
    "Amount": "21.00",
    "Currency": "USD"
  },
  "Debtor": {
    "CustomerType": "ACCOUNT_HOLDER",
    "UserType": "INDIVIDUAL",
    "Identification": "894100103",
    "IdentificationType": "SSN",
    "CustomerNumber": "894100103",
    "InstitutionNumber": "123456789012345",
    "Name": "Benjamin Hill",
    "NameInFile": "Benjamin",
    "Gender": "Male"
  },
  "DebtorDateOfBirth": {
    "Year": "1974",
    "Month": "05",
    "Day": "17",
    "DateOfBirth": "19740517"
  },
  "DebtorPostalAddress": {
    "AddressType": "HOUSE",
    "AddressLine1": "2745 SW VILLA DIRAQ",
    "AddressLine2": "Apt 304",
    "City": "Kansas City",
    "State": "MO",
    "ZipCode": "66610",
    "CountryCode": "840",
    "Nationality": "USA"
  },
  "DebtorContact": {
    "PrimaryEmail": "hill@gmail.com",
    "PrimaryPhone": "0076540014502"
  },
  "DebtorAccount": {
    "AccountNumber": "200502391928095",
    "AccountType": "CHECKING",
    "AccountName": "GENERAL ACCOUNT",
    "Institution": {
      "Name": "Union Savings Bank",
      "Identification": "011102502",
      "IdentificationType": "ABA"
    }
  },
  "DebtorGeoLocation": {
    "Latitude": "13.02354160",
    "Longitude": "80.14923669"
  },
  "Creditor": {
    "CustomerType": "EXTERNAL",
    "UserType": "UNKNOWN",
    "Identification": "994140005",
    "IdentificationType": "SSN",
    "CustomerNumber": "994140005",
    "Name": "Sally Granger"
  },
  "CreditorAccount": {
    "AccountNumber": "8346868364836483",
    "AccountType": "CHECKING",
    "AccountName": "EXTERNAL",
    "Institution": {
      "Identification": "021000021",
      "IdentificationType": "ABA",
      "Name": "JPMORGAN CHASE BANK"
    }
  },
  "CreditorDateOfBirth": {
    "Year": "1970",
    "Month": "11",
    "Day": "15"
  },
  "CreditorPostalAddress": {
    "AddressType": "HOUSE",
    "AddressLine1": "3745 SW VENEZULA CUBARD IRANMA",
    "AddressLine2": "Suite C",
    "City": "Topeka",
    "State": "KS",
    "ZipCode": "66610",
    "CountryCode": "840",
    "Nationality": " VENEZUALA ",
    "Country": "VENEZUALA"
  },
  "CreditorContact": {
    "PrimaryEmail": "sally@gmail.com",
    "PrimaryPhone": "00178500146156"
  },
  "FedDetails": {
    "FedSender": {
      "Identification": "011102502",
      "IdentificationType": "ABA",
      "Name": "Union Savings Bank"
    },
    "FedReceiver": {
      "Identification": "021000021",
      "IdentificationType": "ABA",
      "Name": "JPMORGAN CHASE BANK"
    }
  },
  "Risk": {
    "MachineFingerPrint": {
      "IpAddress": "98.186.126.180",
      "OperatingSystem": "Mac OS",
      "WebBrowser": "safari",
      "Uuid": "7609EFD3-CED4-440F-9C18-D330EE9311FC",
      "Model": "iPhone",
      "SystemName": "iOS",
      "SystemVersion": "13.3.1",
      "PhoneName": "My IPHONE",
      "Imei": "",
      "SessionId": "",
      "OperatingSystemFamily": "MAC_OS",
      "OperatingSystemProducer": "Apple Computer, Inc."
    },
    "GeoLocation": {
      "Latitude": "39.75931104",
      "Longitude": "-105.01091174"
    }
  }
}

Response: 200

Payload Parameters

Parameter	Description
id	String ID of the request Example – "db2977fb-59cc-4231-b9a8-30c3e33e1467"
jsonrpc	String JSON-RPC version used for the API Example – "2.0"
method	String API method Example – "ce.event"
result	Object
resp	String Type of response Example – "event"
status	String Status of the event Example – "1"
riskScore	Number Estimated Risk score of the transaction Example – 905
signalScore	Number Signal reliability score of the transaction Example – 905
scenarioScore	Number Score of specific scenarios related to the transaction event Example – 0
tokenScore	Number Score of token authentication used in the transaction Example – 0
categoryScore	Number Event category score of transaction Example – 0
ofacConfidentScore	Number Estimated score of compliance with OFAC regulations Example – 0
debtorProfileId	String Unique ID of debtor profile Example – "9C1C1A87D297C038D71DD1623F03191D"
creditorProfileId	String Unique ID of creditor profile Example – "2CED9F48EE3B49D97D9263F1AEAB26D8"
error	null Shows information, if any error occurs during transaction Example – null

{
  "id": "db2977fb-59cc-4231-b9a8-30c3e33e1467",
  "jsonrpc": "2.0",
  "method": "ce.event",
  "result": {
    "resp": "event",
    "status": "1",
    "riskScore": 905,
    "signalScore": 905,
    "scenarioScore": 0,
    "tokenScore": 0,
    "categoryScore": 0,
    "ofacConfidentScore": 0,
    "debtorProfileId": "9C1C1A87D297C038D71DD1623F03191D",
    "creditorProfile": "2CED9F48EE3B49D97D9263F1AEAB26D8"
  },
  "error": null
}

RTP OUTBOUND

Method: POST​

Headers​

Example​

Body​

Response: 200​

Method: POST

Headers

Example

Body

Response: 200